EigrpProcess is the process that handles the individual EIGRP AS process. More...

Inheritance diagram for EigrpProcess:

Public Member Functions
int	getASNumber ()
	Returns the AS number of this EIGRP process. More...

void	setKs (int, int, int, int, int)
	Sets the K-values to the specified values. More...

void	setVariance (int)
	Sets the variance to the specified value. More...

int	getVariance ()
	Returns the variance of this EIGRP process. More...

void	setAutoSummary (bool)
	Enables or disables auto summary on this EIGRP process. More...

bool	getAutoSummary ()
	Returns true if auto summary is enabled on this EIGRP process, otherwise false. More...

void	setDefaultPassiveInt (bool)
	Enables or disables default passive interface on this EIGRP process. More...

bool	getDefaultPassiveInt ()
	Returns true if default passive interface is enabled on this EIGRP process, otherwise false. More...

void	setPassiveInt (string, bool)
	Enables or disables passive interface on the specified port. More...

bool	isPassiveInt (string)
	Returns true if passive interface is enabled on the specified port, otherwise false. More...

void	setIntAdminDistance (int)
	Sets the internal administrative distance on this EIGRP process. More...

void	setExtAdminDistance (int)
	Sets the external administrative distance on this EIGRP process. More...

void	addConfiguredNetwork (ip, ip)
	Adds the network with the specified network address and mask to this EIGRP process. More...

void	removeConfiguredNetwork (ip, ip)
	Removes the network with the specified network address and mask from this EIGRP process. More...

int	getConfiguredNetworkCount ()
	Returns the number of networks in this EIGRP process. More...

bool	addSummaryAddress (string, ip, ip, int)
	Adds a summary aggregate address to the specified port. More...

bool	removeSummaryAddress (string, ip, ip, int)
	Removes a summary aggregate address to the specified port. More...

int	getSummaryAddressCount (string)
	Returns the number of summary aggregate addresses on the specified port. More...

EigrpSummaryAddress	getSummaryAddressAt (string, int, int)
	Returns the summary aggregate address on the specified port, AS number, and index. More...

EigrpTopologyTable	getTopologyTable ()
	Returns the topology table of this EIGRP process. More...

EigrpNeighborTable	getNeighborTable ()
	Returns the neighbor table of this EIGRP process. More...

Public Member Functions inherited from RoutingProtocol
void	setAdminDistance (int)
	Sets the administrative distance. More...

int	getAdminDistance ()
	Returns the administrative distance. More...

Public Member Functions inherited from Process
Device	getOwnerDevice ()
	Returns the device for this process. More...

Detailed Description

EigrpProcess is the process that handles the individual EIGRP AS process.

Member Function Documentation

◆ addConfiguredNetwork()

void EigrpProcess::addConfiguredNetwork	(	ip	,
		ip
	)

Adds the network with the specified network address and mask to this EIGRP process.

Parameters

ipAddress,the	network address.
mask,the	network mask.

◆ addSummaryAddress()

bool EigrpProcess::addSummaryAddress	(	string	,
		ip	,
		ip	,
		int
	)

Adds a summary aggregate address to the specified port.

Parameters

portName,portName	can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0
ipAddress,the	summary IP address.
subnet,the	summary subnet mask.
adminDistance,the	administrative distance.

Returns: bool, true if successful, otherwise false.

◆ getASNumber()

int EigrpProcess::getASNumber ( )

Returns the AS number of this EIGRP process.

Returns: int, the AS number of this EIGRP process.

◆ getAutoSummary()

bool EigrpProcess::getAutoSummary ( )

Returns true if auto summary is enabled on this EIGRP process, otherwise false.

Returns: bool, true if auto summary is enabled on this EIGRP process, otherwise false.

◆ getConfiguredNetworkCount()

int EigrpProcess::getConfiguredNetworkCount ( )

Returns the number of networks in this EIGRP process.

Returns: int, the number of networks in this EIGRP process.

◆ getDefaultPassiveInt()

bool EigrpProcess::getDefaultPassiveInt ( )

Returns true if default passive interface is enabled on this EIGRP process, otherwise false.

Returns: bool, true if default passive interface is enabled on this EIGRP process, otherwise false.

◆ getNeighborTable()

EigrpNeighborTable EigrpProcess::getNeighborTable ( )

Returns the neighbor table of this EIGRP process.

Returns: EigrpNeighborTable, the EigrpNeighborTable object of this EIGRP process.

◆ getSummaryAddressAt()

EigrpSummaryAddress EigrpProcess::getSummaryAddressAt	(	string	,
		int	,
		int
	)

Returns the summary aggregate address on the specified port, AS number, and index.

Parameters

portName	portName can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0
as,the	autonomous system of the summary aggregate address of interest.
index,the	index of the summary aggregate address of interest.

Returns: EigrpSummaryAddress, the EigrpSummaryAddress object on the specified port, AS number, and index.

◆ getSummaryAddressCount()

int EigrpProcess::getSummaryAddressCount ( string )

Returns the number of summary aggregate addresses on the specified port.

Parameters

portName portName can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0

Returns: int, the number of summary aggregate addresses on the specified port.

◆ getTopologyTable()

EigrpTopologyTable EigrpProcess::getTopologyTable ( )

Returns the topology table of this EIGRP process.

Returns: EigrpTopologyTable, the EigrpTopologyTable object of this EIGRP process.

◆ getVariance()

int EigrpProcess::getVariance ( )

Returns the variance of this EIGRP process.

Returns: int, the variance of this EIGRP process.

◆ isPassiveInt()

bool EigrpProcess::isPassiveInt ( string )

Returns true if passive interface is enabled on the specified port, otherwise false.

Parameters

portName,portName can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0

Returns: bool, true if passive interface is enabled on the specified port, otherwise false.

◆ removeConfiguredNetwork()

void EigrpProcess::removeConfiguredNetwork	(	ip	,
		ip
	)

Removes the network with the specified network address and mask from this EIGRP process.

Parameters

ipAddress,the	network address of interest.
mask,the	network mask of interest.

◆ removeSummaryAddress()

bool EigrpProcess::removeSummaryAddress	(	string	,
		ip	,
		ip	,
		int
	)

Removes a summary aggregate address to the specified port.

Parameters

portName,portName	can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0
ipAddress,the	summary IP address.
subnet,the	summary subnet mask.
adminDistance,the	administrative distance.

Returns: bool, true if successful, otherwise false.

◆ setAutoSummary()

void EigrpProcess::setAutoSummary ( bool )

Enables or disables auto summary on this EIGRP process.

Parameters

bAutoSum,true to enable auto summary, false to disable it.

◆ setDefaultPassiveInt()

void EigrpProcess::setDefaultPassiveInt ( bool )

Enables or disables default passive interface on this EIGRP process.

Parameters

bEnable,true to enable default passive interface on this EIGRP process, false to disable it.

◆ setExtAdminDistance()

void EigrpProcess::setExtAdminDistance ( int )

Sets the external administrative distance on this EIGRP process.

Parameters

adminDistance,the external administrative distance.

◆ setIntAdminDistance()

void EigrpProcess::setIntAdminDistance ( int )

Sets the internal administrative distance on this EIGRP process.

Parameters

adminDistance,the internal administrative distance.

◆ setKs()

void EigrpProcess::setKs	(	int	,
		int	,
		int	,
		int	,
		int
	)

Sets the K-values to the specified values.

Parameters

k1,the	K1 value.
k2,the	K2 value.
k3,the	K3 value.
k4,the	K4 value.
k5,the	K5 value.

◆ setPassiveInt()

void EigrpProcess::setPassiveInt	(	string	,
		bool
	)

Enables or disables passive interface on the specified port.

Parameters

portName,portName	can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0
bPassive,true	to enable passive interface, false to disable it.

◆ setVariance()

void EigrpProcess::setVariance ( int )

Sets the variance to the specified value.

Parameters

variance,the variance value.

The documentation for this class was generated from the following file:

CEIGRPProcess.pki

Public Member Functions

Detailed Description

Member Function Documentation

◆ addConfiguredNetwork()

◆ addSummaryAddress()

◆ getASNumber()

◆ getAutoSummary()

◆ getConfiguredNetworkCount()

◆ getDefaultPassiveInt()

◆ getNeighborTable()

◆ getSummaryAddressAt()

◆ getSummaryAddressCount()

◆ getTopologyTable()

◆ getVariance()

◆ isPassiveInt()

◆ removeConfiguredNetwork()

◆ removeSummaryAddress()

◆ setAutoSummary()

◆ setDefaultPassiveInt()

◆ setExtAdminDistance()

◆ setIntAdminDistance()

◆ setKs()

◆ setPassiveInt()

◆ setVariance()